Comment (computer programming)
part 34/37 · 66.0 KB total
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
cite-note-javadoc000-3131. ↑ "How to Write Doc Comments for the Javadoc Tool". Retrieved 2007-07-24. Javadoc guidelines specify that comments are crucial to the platform. Further, the appropriate level of detail is fairly well-defined: "We spend time and effort focused on specifying boundary conditions, argument ranges and corner cases rather than defining common programming terms, writing conceptual overviews, and including examples for developers."
cite-note-techniques001-3232. ↑ citerefyourdon2007Yourdon, Edward (2007). Techniques of Program Structure and Design. University of Michigan. 013901702X.Non-existent comments can make it difficult to comprehend code, but comments may be detrimental if they are obsolete, redundant, incorrect or otherwise make it more difficult to comprehend the intended purpose for the source code.
cite-note-gnome000-3434. ↑ "Coding Style". Archived from the original on 2007-08-08. Retrieved 2007-07-24.
cite-note-holub000-3535. ↑ "Allen Holub". Archived from the original on 2007-07-20. Retrieved 2007-07-24.
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────